Google Git
Sign in
chromium / external / gitster / git-htmldocs / 47d68a53947d51de4f67b6b7e4e7f76e71e16fb5 / . / git-help.html
blob: f3d698fd2b347395675dd674c0a94590d6bcaca5 [file] [log] [blame]
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
6<meta name="generator" content="AsciiDoc 7.0.2" />
7<style type="text/css">
8/* Debug borders */
9p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
10/*
11 border: 1px solid red;
12*/
13}
14
15body {
16 margin: 1em 5% 1em 5%;
17}
18
19a { color: blue; }
20a:visited { color: fuchsia; }
21
22em {
23 font-style: italic;
24}
25
26strong {
27 font-weight: bold;
28}
29
30tt {
31 color: navy;
32}
33
34h1, h2, h3, h4, h5, h6 {
35 color: #527bbd;
36 font-family: sans-serif;
37 margin-top: 1.2em;
38 margin-bottom: 0.5em;
39 line-height: 1.3;
40}
41
42h1 {
43 border-bottom: 2px solid silver;
44}
45h2 {
46 border-bottom: 2px solid silver;
47 padding-top: 0.5em;
48}
49
50div.sectionbody {
51 font-family: serif;
52 margin-left: 0;
53}
54
55hr {
56 border: 1px solid silver;
57}
58
59p {
60 margin-top: 0.5em;
61 margin-bottom: 0.5em;
62}
63
64pre {
65 padding: 0;
66 margin: 0;
67}
68
69span#author {
70 color: #527bbd;
71 font-family: sans-serif;
72 font-weight: bold;
73 font-size: 1.2em;
74}
75span#email {
76}
77span#revision {
78 font-family: sans-serif;
79}
80
81div#footer {
82 font-family: sans-serif;
83 font-size: small;
84 border-top: 2px solid silver;
85 padding-top: 0.5em;
86 margin-top: 4.0em;
87}
88div#footer-text {
89 float: left;
90 padding-bottom: 0.5em;
91}
92div#footer-badges {
93 float: right;
94 padding-bottom: 0.5em;
95}
96
97div#preamble,
98div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
99div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
100div.admonitionblock {
101 margin-right: 10%;
102 margin-top: 1.5em;
103 margin-bottom: 1.5em;
104}
105div.admonitionblock {
106 margin-top: 2.5em;
107 margin-bottom: 2.5em;
108}
109
110div.content { /* Block element content. */
111 padding: 0;
112}
113
114/* Block element titles. */
115div.title, caption.title {
116 font-family: sans-serif;
117 font-weight: bold;
118 text-align: left;
119 margin-top: 1.0em;
120 margin-bottom: 0.5em;
121}
122div.title + * {
123 margin-top: 0;
124}
125
126td div.title:first-child {
127 margin-top: 0.0em;
128}
129div.content div.title:first-child {
130 margin-top: 0.0em;
131}
132div.content + div.title {
133 margin-top: 0.0em;
134}
135
136div.sidebarblock > div.content {
137 background: #ffffee;
138 border: 1px solid silver;
139 padding: 0.5em;
140}
141
142div.listingblock > div.content {
143 border: 1px solid silver;
144 background: #f4f4f4;
145 padding: 0.5em;
146}
147
148div.quoteblock > div.content {
149 padding-left: 2.0em;
150}
151div.quoteblock .attribution {
152 text-align: right;
153}
154
155div.admonitionblock .icon {
156 vertical-align: top;
157 font-size: 1.1em;
158 font-weight: bold;
159 text-decoration: underline;
160 color: #527bbd;
161 padding-right: 0.5em;
162}
163div.admonitionblock td.content {
164 padding-left: 0.5em;
165 border-left: 2px solid silver;
166}
167
168div.exampleblock > div.content {
169 border-left: 2px solid silver;
170 padding: 0.5em;
171}
172
173div.verseblock div.content {
174 white-space: pre;
175}
176
177div.imageblock div.content { padding-left: 0; }
178div.imageblock img { border: 1px solid silver; }
179span.image img { border-style: none; }
180
181dl {
182 margin-top: 0.8em;
183 margin-bottom: 0.8em;
184}
185dt {
186 margin-top: 0.5em;
187 margin-bottom: 0;
188 font-style: italic;
189}
190dd > *:first-child {
191 margin-top: 0;
192}
193
194ul, ol {
195 list-style-position: outside;
196}
197ol.olist2 {
198 list-style-type: lower-alpha;
199}
200
201div.tableblock > table {
202 border-color: #527bbd;
203 border-width: 3px;
204}
205thead {
206 font-family: sans-serif;
207 font-weight: bold;
208}
209tfoot {
210 font-weight: bold;
211}
212
213div.hlist {
214 margin-top: 0.8em;
215 margin-bottom: 0.8em;
216}
217td.hlist1 {
218 vertical-align: top;
219 font-style: italic;
220 padding-right: 0.8em;
221}
222td.hlist2 {
223 vertical-align: top;
224}
225
226@media print {
227 div#footer-badges { display: none; }
228}
229include::./stylesheets/xhtml11-manpage.css[]
230/* Workarounds for IE6's broken and incomplete CSS2. */
231
232div.sidebar-content {
233 background: #ffffee;
234 border: 1px solid silver;
235 padding: 0.5em;
236}
237div.sidebar-title, div.image-title {
238 font-family: sans-serif;
239 font-weight: bold;
240 margin-top: 0.0em;
241 margin-bottom: 0.5em;
242}
243
244div.listingblock div.content {
245 border: 1px solid silver;
246 background: #f4f4f4;
247 padding: 0.5em;
248}
249
250div.quoteblock-content {
251 padding-left: 2.0em;
252}
253
254div.exampleblock-content {
255 border-left: 2px solid silver;
256 padding-left: 0.5em;
257}
258</style>
259<title>git-help(1)</title>
260</head>
261<body>
262<div id="header">
263<h1>
264git-help(1) Manual Page
265</h1>
266<h2>NAME</h2>
267<div class="sectionbody">
268<p>git-help -
269 display help information about git
270</p>
271</div>
272</div>
273<h2>SYNOPSIS</h2>
274<div class="sectionbody">
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]275<p><em>git help</em> [-a|--all|-i|--info|-m|--man|-w|--web] [COMMAND]</p>
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]276</div>
277<h2>DESCRIPTION</h2>
278<div class="sectionbody">
279<p>With no options and no COMMAND given, the synopsis of the <em>git</em>
280command and a list of the most commonly used git commands are printed
281on the standard output.</p>
282<p>If the option <em>--all</em> or <em>-a</em> is given, then all available commands are
283printed on the standard output.</p>
284<p>If a git command is named, a manual page for that command is brought
Junio C Hamano0c0da5f2007-12-13 02:45:30[diff] [blame]285up. The <em>man</em> program is used by default for this purpose, but this
Junio C Hamanofe986052007-12-19 07:33:38[diff] [blame]286can be overridden by other options or configuration variables.</p>
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]287<p>Note that <em>git --help &#8230;</em> is identical as <em>git help &#8230;</em> because the
288former is internally converted into the latter.</p>
289</div>
290<h2>OPTIONS</h2>
291<div class="sectionbody">
292<dl>
293<dt>
294-a|--all
295</dt>
296<dd>
297<p>
298 Prints all the available commands on the standard output. This
Junio C Hamanofe986052007-12-19 07:33:38[diff] [blame]299 option supersedes any other option.
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]300</p>
301</dd>
Junio C Hamano0c0da5f2007-12-13 02:45:30[diff] [blame]302<dt>
303-i|--info
304</dt>
305<dd>
306<p>
Junio C Hamano8b588d52008-03-15 09:48:37[diff] [blame]307 Display manual page for the command in the <em>info</em> format. The
308 <em>info</em> program will be used for that purpose.
Junio C Hamano0c0da5f2007-12-13 02:45:30[diff] [blame]309</p>
310</dd>
311<dt>
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]312-m|--man
313</dt>
314<dd>
315<p>
Junio C Hamano8b588d52008-03-15 09:48:37[diff] [blame]316 Display manual page for the command in the <em>man</em> format. This
317 option may be used to override a value set in the
318 <em>help.format</em> configuration variable.
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]319</p>
Junio C Hamano8b588d52008-03-15 09:48:37[diff] [blame]320<p>By default the <em>man</em> program will be used to display the manual page,
321but the <em>man.viewer</em> configuration variable may be used to choose
322other display programs (see below).</p>
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]323</dd>
324<dt>
Junio C Hamano0c0da5f2007-12-13 02:45:30[diff] [blame]325-w|--web
326</dt>
327<dd>
328<p>
Junio C Hamano8b588d52008-03-15 09:48:37[diff] [blame]329 Display manual page for the command in the <em>web</em> (HTML)
330 format. A web browser will be used for that purpose.
Junio C Hamano0c0da5f2007-12-13 02:45:30[diff] [blame]331</p>
332<p>The web browser can be specified using the configuration variable
333<em>help.browser</em>, or <em>web.browser</em> if the former is not set. If none of
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]334these config variables is set, the <em>git-web--browse</em> helper script
335(called by <em>git-help</em>) will pick a suitable default. See
336<a href="git-web--browse.html">git-web--browse(1)</a> for more information about this.</p>
Junio C Hamano0c0da5f2007-12-13 02:45:30[diff] [blame]337</dd>
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]338</dl>
339</div>
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]340<h2>CONFIGURATION VARIABLES</h2>
341<div class="sectionbody">
Junio C Hamano8b588d52008-03-15 09:48:37[diff] [blame]342<h3>help.format</h3>
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]343<p>If no command line option is passed, the <em>help.format</em> configuration
344variable will be checked. The following values are supported for this
345variable; they make <em>git-help</em> behave as their corresponding command
346line option:</p>
347<ul>
348<li>
349<p>
350"man" corresponds to <em>-m|--man</em>,
351</p>
352</li>
353<li>
354<p>
355"info" corresponds to <em>-i|--info</em>,
356</p>
357</li>
358<li>
359<p>
Junio C Hamano8b588d52008-03-15 09:48:37[diff] [blame]360"web" or "html" correspond to <em>-w|--web</em>.
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]361</p>
362</li>
363</ul>
Junio C Hamano8b588d52008-03-15 09:48:37[diff] [blame]364<h3>help.browser, web.browser and browser.&lt;tool&gt;.path</h3>
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]365<p>The <em>help.browser</em>, <em>web.browser</em> and <em>browser.&lt;tool&gt;.path</em> will also
Junio C Hamanofe986052007-12-19 07:33:38[diff] [blame]366be checked if the <em>web</em> format is chosen (either by command line
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]367option or configuration variable). See <em>-w|--web</em> in the OPTIONS
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]368section above and <a href="git-web--browse.html">git-web--browse(1)</a>.</p>
Junio C Hamano8b588d52008-03-15 09:48:37[diff] [blame]369<h3>man.viewer</h3>
370<p>The <em>man.viewer</em> config variable will be checked if the <em>man</em> format
371is chosen. Only the following values are currently supported:</p>
372<ul>
373<li>
374<p>
375"man": use the <em>man</em> program as usual,
376</p>
377</li>
378<li>
379<p>
380"woman": use <em>emacsclient</em> to launch the "woman" mode in emacs
381(this only works starting with emacsclient versions 22),
382</p>
383</li>
384<li>
385<p>
386"konqueror": use a man KIO slave in konqueror.
387</p>
388</li>
389</ul>
390<p>Multiple values may be given to this configuration variable. Their
391corresponding programs will be tried in the order listed in the
392configuration file.</p>
393<p>For example, this configuration:</p>
394<div class="literalblock">
395<div class="content">
396<pre><tt>[man]
397 viewer = konqueror
398 viewer = woman</tt></pre>
399</div></div>
400<p>will try to use konqueror first. But this may fail (for example if
401DISPLAY is not set) and in that case emacs' woman mode will be tried.</p>
402<p>If everything fails the <em>man</em> program will be tried anyway.</p>
403<h3>Note about git config --global</h3>
404<p>Note that all these configuration variables should probably be set
405using the <em>--global</em> flag, for example like this:</p>
Junio C Hamano3dac5042007-12-15 08:40:54[diff] [blame]406<div class="listingblock">
407<div class="content">
408<pre><tt>$ git config --global help.format web
409$ git config --global web.browser firefox</tt></pre>
410</div></div>
411<p>as they are probably more user specific than repository specific.
412See <a href="git-config.html">git-config(1)</a> for more information about this.</p>
413</div>
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]414<h2>Author</h2>
415<div class="sectionbody">
416<p>Written by Junio C Hamano &lt;gitster@pobox.com&gt; and the git-list
417&lt;git@vger.kernel.org&gt;.</p>
418</div>
419<h2>Documentation</h2>
420<div class="sectionbody">
421<p>Initial documentation was part of the <a href="git.html">git(7)</a> man page.
422Christian Couder &lt;chriscool@tuxfamily.org&gt; extracted and rewrote it a
423little. Maintenance is done by the git-list &lt;git@vger.kernel.org&gt;.</p>
424</div>
425<h2>GIT</h2>
426<div class="sectionbody">
427<p>Part of the <a href="git.html">git(7)</a> suite</p>
428</div>
429<div id="footer">
430<div id="footer-text">
Junio C Hamano8b588d52008-03-15 09:48:37[diff] [blame]431Last updated 15-Mar-2008 09:48:17 UTC
Junio C Hamano58256872007-12-04 08:31:13[diff] [blame]432</div>
433</div>
434</body>
435</html>